CRPEJob::SetGroupCondition
Syntax
SetGroupCondition (sectionCode SMALLINT,conditionField CHAR(*), condition SMALLINT, sortDirection SMALLINT) RETURNING BOOLEAN
Parameters
sectionCode
| Specifies the Section Codes, for the section of the report for which you want to set group condition information.
|
conditionField
| Specifies the field that triggers a summary whenever its value changes. Use the name of the field as indicated in the report file.
|
condition
| Specifies the condition that needs to be met for Date and Boolean fields. For all field types except Date and Boolean, use PEP_GC_ANYCHANGE as the condition parameter.
|
| Value (Date Fields)
| Meaning
|
| PEP_GC_DAILY
| Triggers a grouping every time the date changes.
|
| PEP_GC_WEEKLY
| Triggers a grouping every time the date changes from one week to the next (a week runs from Sunday through Saturday).
|
| PEP_GC_BIWEEKLY
| Triggers a grouping every time the date changes from one two-week period to the next.
|
| PEP_GC_SEMIMONTHLY
| Triggers a grouping every time the date changes from one half-month period to the next.
|
| PEP_GC_MONTHLY
| Triggers a grouping every time the date changes from one month to the next.
|
| PEP_GC_QUARTERLY
| Triggers a grouping every time the date changes from one calendar quarter to the next.
|
| PEP_GC_SEMIANNUALLY
| Triggers a grouping every time the date changes from one half-year period to the next.
|
| PEP_GC_ANNUALLY
| Triggers a grouping every time the date changes from one year to the next.
|
| Value (Boolean Fields)
| Meaning
|
| PEP_GC_TOYES
| Triggers a grouping every time the sort and group by field changes from No to Yes.
|
| PEP_GC_TONO
| Triggers a grouping every time the sort and group by field changes from Yes to No.
|
| PEP_GC_EVERYYES
| Triggers a grouping every time the group and sort by field value is Yes.
|
| PEP_GC_EVERYNO
| Triggers a grouping every time the group and sort by field value is No.
|
| PEP_GC_NEXTISYES
| Triggers a grouping every time the next value in the sort and group by field is Yes.
|
| PEP_GC_NEXTISNO
| Triggers a grouping every time the next value in the sort and group by field is No.
|
Remarks
This method sets the condition of the grouping for the specified group section. This method can only replace the group condition for an existing group. It cannot create a new group. Use this function whenever you want to change the grouping at print time, for example, to print one report grouped in several different ways.
Returns
- TRUE if the call is successful.
- FALSE if the call fails.
Related Topics
PESetGroupCondition